-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Create FAQ page in sphinx User Guide #1549
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Hi @kanderso-nrel pvlib sounds pretty cool! Is there anything I shouldn't use pvlib for or that it can't do? Financial calculations, uneven terrain? |
Where can I get irradiance data for my simulation? |
Co-Authored-By: Adam R. Jensen <[email protected]>
Co-authored-by: Adam R. Jensen <[email protected]>
Glad to hear you think so! I agree :)
I'm a little hesitant to include a list of things that pvlib is unsuitable for. For one, that list is infinitely long. For another, what is unsuitable depends on the user -- for example I myself would surely turn to pvlib if I were tasked with modeling a system on uneven terrain, but I might not recommend others do the same. I did try to implicitly address the financial calculations point by specifying electrical performance in the "what is pvlib?" question. On the other hand, "how do I model variable terrain in pvlib?" has been asked before, so maybe that should be an item on its own? |
This reverts commit 3fe89f8.
I have added a link to the README as @cwhanse suggested in #1546 (comment). Finding myself with no motivation to write an entry on variable terrain, I suggest we proceed with the current set of FAQ entries and expand the list in future PRs. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Approving, some optional edits if you agree that they add clarification.
Co-authored-by: Cliff Hansen <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me.
[ ] Tests added[ ] Updates entries indocs/sphinx/source/reference
for API changes.docs/sphinx/source/whatsnew
for all changes. Includes link to the GitHub Issue with:issue:`num`
or this Pull Request with:pull:`num`
. Includes contributor name and/or GitHub username (link with:ghuser:`user`
).[ ] New code is fully documented. Includes numpydoc compliant docstrings, examples, and comments where necessary.remote-data
) and Milestone are assigned to the Pull Request and linked Issue.Here's a first crack at an FAQ page. Additions and revisions are very welcome. I've marked it for 0.9.3 but also fine to push it to later.
Rendered page: https://pvlib-python--1549.org.readthedocs.build/en/1549/user_guide/faq.html